home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Screenblankers / Roxblanker / RoxBlanker.doc < prev    next >
Text File  |  1996-09-26  |  5KB  |  146 lines
  1.  
  2. ------------------------------------------------------------------------
  3. RoxBlanker III -- Copyright 1992 Sleepless Software  All Rights Reserved
  4. ------------------------------------------------------------------------
  5.  
  6. ----------------------------------------------------------------
  7. This software package and all files and data included with it
  8. is/are copyrighted material. Nothing contained herein may be
  9. reproduced or distributed without the express written consent of
  10. the copyright holders except for the following special case;
  11. Permission is hereby given by the copyright holder(s) to
  12. distribute copies of this software package provided that the
  13. copies distributed are in exactly the same form as originally
  14. received and provided that no net profit or gain of any kind is
  15. made by any party involved in the transaction.
  16. ----------------------------------------------------------------
  17.  
  18.  
  19.  
  20.  
  21.  
  22. ----------------------------------------------------------------
  23. RoxBlanker III -- Documentation
  24. ----------------------------------------------------------------
  25.  
  26. Author     : Joe Hitchens
  27. Created    : December 11, 1991 (or thereabouts)
  28. Last update: Wed,  8 Apr 92
  29. Version    : 8.4.92
  30.  
  31. RoxBlanker III is a fancy screenblanker program. It blanks the
  32. screen by running animation files which were created with a
  33. program called Roxanne. It is based on the original RoxBlanker
  34. which was launched by SleepyCron at idle time. This version is
  35. a standalone version that does not require SleepyCron.
  36. But get SleepyCron anyway, because it's way cool.
  37.  
  38.  
  39. RoxBlanker should be run by your startup-sequence something like this:
  40.  
  41.      cd roxfiles:
  42.      run >nil: roxblanker file1.rox file2.rox file3.rox (etc.)
  43.  
  44. When the system becomes idle (about 4 minutes of inactivity), one of the
  45. .rox files given on the command line will be picked at random and
  46. animated as a screenblanker.
  47.  
  48. To make RoxBlanker exit, you must ^D or ^C it.  You may have to
  49. use the 'break' command to do this.  See your Amiga documentation
  50. on how the use the CLI 'break' command.
  51.  
  52. To force the program to blank immediately, use 'break e'.
  53. This is useful for testing the blanker to make sure it can
  54. load all of the .rox files you gave it ... just do this:
  55.  
  56.     1> roxblanker file1.rox file2.rox (etc.)
  57.  
  58. Note that 'run' was not used. Type ^E to cause a blank over
  59. and over until you are sure you have seen all the .rox files.
  60. Then you can run it in the background from the startup-sequence
  61. normally.  You have to type ^E and release both keys VERY QUICKLY,
  62. because if you don't, the screen will blank and then instantly
  63. unblank when the program detects your 'key release'.
  64.  
  65. RoxBlanker will stop blanking when the mouse is moved or a
  66. key is pressed.
  67.  
  68. Remember, the .rox files have to be specified with an absolute
  69. path, that's why you need to 'cd' to the directory ... so you don't
  70. have to type dh0:dir1/stuff/roxfiles/roxfile1.rox for every argument.
  71.  
  72. There are two magic keywords which you can use.
  73.      1. TIMEOUT
  74.      2. VERSION
  75.  
  76. To specify the blanking interval in seconds use the TIMEOUT keyword
  77. like this:
  78.  
  79.     1> roxblanker timeout 300 a.rox b.rox (etc.)
  80.  
  81. In this example, the screen will blank after 300 seconds (5 minutes)
  82. of mouse and keyboard inactivity.
  83.  
  84. To get a precise version number for your copy of RoxBlanker, use
  85. the keyword VERSION like this:
  86.  
  87.     1> roxblanker version a.rox b.rox (etc.)
  88.  
  89. RoxBlanker will then print out something like this:
  90.  
  91.    RoxBlanker III -- Copyright 1992 Sleepless Software All Rights Reserved
  92.    Last update: Wed,  8 Apr 92 14:21:19
  93.    Version  8.4.92
  94.    Timeout: 240 seconds
  95.  
  96. This tells you, down to the second, when your copy of the program was
  97. compiled.
  98.  
  99.  
  100.  
  101. RoxBlanker DOES use up a certain amount of chip ram when it
  102. blanks.  It opens an intuition screen of up to 5 bitplanes (I don't
  103. think any of the .rox files here are more than 3) and 2 more bitmaps
  104. of equal size to the first screen (for double buffering).
  105. So if you are tight on memory, RoxBlanker could have trouble
  106. blanking.  If your machine always has very little free memory
  107. available, RoxBlanker may not work out for you.
  108.  
  109. I plan to make it possible for RoxBlanker to blank the screen with
  110. NO additional memory so that if it DOES have trouble running the
  111. Roxanne animation it will still blank.
  112. There is not yet any control of input handler
  113. priority, or wild cards for specifying many .rox files.
  114. Register your copy of RoxBlanker according to the shareware
  115. information provided to let me know if you think these
  116. (or other things) are important to you.
  117.  
  118. How to reach me by mail:
  119.  
  120.   Joe Hitchens
  121.   45 North Main
  122.   North Salt Lake, UT  84054
  123.  
  124. How to reach me by phone:
  125.  
  126.   (801) 359-5514  or
  127.   (801) 292-2190
  128.  
  129. How to reach me by email:
  130.  
  131.   jhitchen@magna.math.utah.edu
  132.   or
  133.   joe@vixen.uucp
  134.   or
  135.   joe@olga.uucp
  136.   or
  137.   ...!uunet!iconsys!caeco!olga!joe
  138.  
  139.  
  140.  
  141.  
  142. j.h.
  143. April 8, 1992
  144.  
  145.  
  146.